OpenSearch Overview

OpenSearch is a collection of simple formats for the sharing of search results.
The OpenSearch description document format is used to describe a search engine that can be used by search client applications.

The OpenSearch response elements can be used to extend existing syndication formats, such as RSS and Atom, with the extra metadata needed to return search results. The OpenSearch document is associated with the "application/opensearchdescription+xml" mime type.

Note For more detailed information about Open Search, refers to the Open Search home page at http://www.opensearch.org/Home

Data Model

Apache Wink provides an Open Search data model for producing Open Search Documents. of the model classes are located under the org.apache.wink.common.model.opensearch package. OpenSearchDescription class is used by an application to build Open Search Description documents.

OpenSearch Support

The following table shows the OpenSearch data model and representation in which it can be serialized and de-serialized.

Producing an OpenSearch Document Example

The following example demonstrates the creation of an OpenSearch document.

      @GET
    @Produces(MediaTypeUtils.OPENSEARCH)
    public OpenSearchDescription getOpenSearch(@Context UriInfo info) {
        String baseUri = info.getAbsolutePath().toString();
        OpenSearchDescription openSearchDescription = new OpenSearchDescription();
        openSearchDescription.setShortName("Example search engine");
        ...
        return openSearchDescription;
}